Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.
To demonstrate that bslib cards work outside of Shiny (i.e., in R
Markdown, static HTML, etc), we’ll make repeated use of statically
rendered htmlwidgets like
{plotly} and {leaflet}. Here’s some code to
create those widgets:
library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)
plotly_widget <- plot_ly(x = diamonds$cut) %>%
config(displayModeBar = FALSE) %>%
layout(margin = list(t = 0, b = 0, l = 0, r = 0))
leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
leaflet(options = .) %>%
addTiles()
Cards work equally well in Shiny. In the
examples below, replace plotly_widget with
plotlyOutput() and leaflet_widget with
leafletOutput() to adapt them for Shiny server-rendered
plots/maps.
card()A card() is designed to handle any number of “known”
card items (e.g., card_header(), card_body(),
etc) as unnamed arguments (i.e., children). As we’ll see shortly,
card() also has some useful named arguments (e.g.,
full_screen, height, etc).
At their core, card() and card items are just an HTML
div() with a special Bootstrap class, so you can use
Bootstrap’s utility classes to customize things like colors,
text, borders,
etc.
card(
card_header(
class = "bg-dark",
"A header"
),
card_body(
markdown("Some text with a [link](https://github.com)")
)
)
Some text with a link
card_body()If you find yourself using card_body() without changing
any of its defaults, consider dropping it altogether since any direct
children of card() that aren’t “known” card()
items, are wrapped together into an implicit card_body()
call.1
For example, the code to the right generates HTML that is identical to
the previous example:
card(
card_header(
class = "bg-dark",
"A header"
),
markdown("Some text with a [link](https://github.com).")
)
Some text with a link.
By default, a card()’s size grows to accommodate the
size of it’s contents. Thus, if a card_body() contains a
large amount of text, tables, etc., you may want to specify a
height or max_height. That said, when laying
out multiple cards, it’s likely best not
to specify height on the card(), and instead, let the
layout determine the height layout_column_wrap().
Although scrolling is convenient for reducing the amount of space
required to park lots of content, it can also be a nuisance to the user.
To help reduce the need for scrolling, consider pairing scrolling with
full_screen = TRUE (which adds an icon to expand the card’s
size to the browser window). Notice how, when the card is expanded to
full-screen, max_height/height won’t effect
the full-screen size of the card.
card(
max_height = 250,
full_screen = TRUE,
card_header(
"A long, scrolling, description"
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)
Elit pharetra cras tempus at faucibus, hendrerit, fames congue ultrices lectus. Enim elementum lacinia fusce suscipit; quisque semper etiam erat mauris himenaeos. Varius condimentum nisi euismod, erat porta, ligula pharetra porttitor torquent. Facilisis tempor etiam accumsan, donec eu – non ultrices dictum blandit dui. Aliquam enim ad.
Lorem et aenean, quisque ante habitasse, lectus phasellus lobortis egestas ultricies. Augue lobortis orci turpis dictum: quam mollis: tincidunt velit. Cursus taciti lectus litora feugiat, primis primis aptent conubia id. Habitasse nisi habitasse nibh diam mollis vel; ac nostra penatibus imperdiet cum. Vestibulum sollicitudin lacus phasellus posuere eu per, suspendisse inceptos conubia urna eu.
Consectetur proin velit nascetur porttitor cum, cum tempor convallis lobortis. Vehicula aliquet euismod parturient, tristique condimentum tincidunt interdum ante. Nisi massa suscipit ad aliquam – laoreet scelerisque viverra, cras donec pulvinar tempus eros justo. Ante luctus primis metus magnis, metus sagittis, pharetra lobortis varius. Blandit aenean quisque!
A card()’s default behavior is optimized for
facilitating filling layouts. More
specifically, if a fill item (e.g.,
plotly_widget), appears as a direct child of a
card_body(), it resizes to fit the card()s
specified height. This means, by specifying height = 250
we’ve effectively shrunk the plot’s height from its default of 400 down
to about 200 pixels. And, when expanded to full_screen, the
plot grows to match the card()’s new size.
card(
height = 250,
full_screen = TRUE,
card_header("A filling plot"),
card_body(plotly_widget)
)
Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny
output bindings (e.g, plotOutput(),
imageOutput(), etc) are fill items by
default, so this behavior “just works” in those scenarios. And, in some
of these situations, it’s helpful to remove card_body()’s
padding, which can be done via spacing
& alignment utility classes.
card(
height = 275,
full_screen = TRUE,
card_header("A filling map"),
card_body(
class = "p-0",
leaflet_widget
),
card_footer(
class = "fs-6",
"Copyright 2023 RStudio, PBC"
)
)
Fill item(s) aren’t limited in how much they grow
and shrink, which can be problematic when a card becomes very small. To
work around this, consider adding a min_height on the
card_body() container. For example, try using the handle on
the lower-right portion of this card example to make the card
taller/smaller.
This interactive example is a bit contrived in that we’re using CSS
resize to demonstrate how to make plots that don’t shrink beyond a
certain point, but this concept becomes quite useful when implementing
page-level filling layouts (i.e.,
page_fillable()) with multiple
cards.
card(
height = 300,
style = "resize:vertical;",
card_header("Plots that grow but don't shrink"),
card_body(
min_height = 250,
plotly_widget,
plotly_widget
)
)
As you’ll learn more about in filling
layouts, a fill item loses its ability to fill when
wrapped in additional UI element that isn’t a fillable
container. To fix the situation, use as_fill_carrier() to
allow the additional element to carry the potential to fill from the
card_body() down to the fill item.
card_body()A card() can have multiple card_body()s,
which is especially useful for:
card_body() to have their own styling
(via inline styles and/or utility classes) and resizing limits (e.g.,
min_height).For example, when pairing filling output with scrolling content, you
may want min_height on the filling output since the
scrolling content will force it to shrink:
card(
height = 375,
full_screen = TRUE,
card_header(
"Filling plot, scrolling description"
),
card_body(
min_height = 200,
plotly_widget
),
card_body(
class = "lead container",
lorem::ipsum(paragraphs = 10, sentences = 5)
)
)
Ipsum vulputate netus quisque hac: tempus aliquam, sem tristique lectus mollis, urna augue fringilla magnis! Tempus maecenas eleifend aenean: at auctor, sodales vivamus posuere congue quam duis. Magnis vehicula est cras, magnis nibh facilisis dictum placerat: pellentesque nisl natoque ullamcorper? Tellus vivamus potenti etiam, aliquet urna placerat fames parturient? Ultrices consequat semper semper in?
Elit cras facilisis diam mattis rhoncus integer blandit habitasse gravida dictumst tempor ligula vestibulum dignissim. Luctus non vulputate purus posuere suspendisse ad scelerisque pharetra vehicula turpis ut. Augue nullam, tempus malesuada id tristique primis, nunc dictum, litora consequat luctus? Ligula curae sodales ac nullam sapien purus natoque. Commodo in.
Consectetur in leo: pretium risus aenean faucibus nisi iaculis pretium. Sagittis netus dis pellentesque euismod mattis himenaeos per. Felis lacus inceptos nullam ultricies blandit condimentum vivamus: feugiat leo nunc. Nunc sed, feugiat iaculis facilisi aliquet scelerisque mauris elementum. Cursus cras odio senectus, nunc molestie posuere odio – litora facilisis orci porta integer.
Ipsum gravida congue dictumst lacinia vestibulum sed torquent cubilia? Eget massa lectus cras etiam egestas cursus maecenas aenean bibendum quisque at faucibus. Molestie tristique cras fringilla magna parturient phasellus ac pellentesque hendrerit nullam nascetur? Commodo magnis lobortis; interdum; ac ut eleifend orci libero! Dignissim netus tempor, fermentum mollis proin odio quam, justo dictum quisque habitasse!
Lorem nulla erat – morbi sapien pellentesque tincidunt! Accumsan himenaeos vitae hendrerit taciti himenaeos. Lacinia eget molestie pharetra, nulla porta litora etiam ridiculus. Metus sodales arcu sodales conubia euismod interdum, odio in vitae libero. Vel lectus vehicula vestibulum cum in eros faucibus platea malesuada morbi, sapien eu facilisi, laoreet blandit tincidunt; a penatibus metus sed velit maecenas ornare tempor.
Consectetur praesent posuere nascetur nostra egestas, placerat mus primis, commodo sociis, praesent phasellus ullamcorper maecenas. Morbi montes arcu ultrices, dui scelerisque ligula eu vehicula. Purus rutrum placerat duis sollicitudin nisi vulputate integer convallis. Ligula varius fusce, iaculis nibh ut donec curae justo maecenas dictum libero. Eleifend ante hendrerit magnis est gravida cras.
Ipsum eleifend, curabitur, conubia habitasse class gravida morbi vulputate natoque tempus? Vulputate quisque odio donec tristique, proin ad, litora ullamcorper faucibus augue. In eu per orci semper, per dignissim aptent malesuada erat feugiat libero. Et senectus auctor himenaeos ullamcorper turpis pretium, facilisi metus curabitur. Na curabitur.
Consectetur cum urna dignissim est fames mattis mus hendrerit leo. Risus integer sagittis pulvinar justo nunc; consequat nec, egestas accumsan sociosqu pulvinar donec. Purus fames maecenas, eu ante pretium, praesent primis maecenas vel eu auctor. Fames non etiam urna pretium; ornare ultrices, cubilia dictumst pulvinar. Eleifend arcu.
Amet libero at dignissim nisi torquent, congue aptent fermentum hendrerit scelerisque. Phasellus pharetra ultricies class natoque class platea est eu iaculis in, id quisque donec malesuada? Felis sociosqu odio: massa ultricies mollis venenatis donec? Fringilla egestas ornare mollis consequat sollicitudin dui convallis fusce. In euismod luctus, sed placerat sociosqu, ornare imperdiet vehicula.
Dolor lacinia vel scelerisque nisl facilisi: mattis integer. Nisl feugiat pulvinar a etiam fringilla: pharetra viverra eros semper litora. Nascetur viverra quam sapien massa nam id. Fringilla malesuada et quis tempus, metus phasellus nisl varius nisl ridiculus porttitor! Sodales parturient dictum praesent, ultricies inceptos placerat eget inceptos phasellus posuere nisl fames.
Also, when the content has a fixed size, and should not be allowed to
scroll, set fill = FALSE:
card(
height = 350,
full_screen = TRUE,
card_header(
"Filling plot, short description"
),
plotly_widget,
card_body(
fill = FALSE,
card_title("A subtitle"),
p(class = "text-muted", "And a caption")
)
)
And a caption
As you’ll learn in column-based
layouts, layout_column_wrap() is great for multi-column
layouts that are responsive and accommodate for filling output. Here we have an equal-width
2-column layout using width = 1/2, but it’s also possible
to have varying column
widths.
card(
height = 350,
full_screen = TRUE,
card_header("A multi-column filling layout"),
card_body(
min_height = 200,
layout_column_wrap(
width = 1/2,
plotOutput("p1"),
plotOutput("p2")
)
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)
Elit hac et aptent lobortis fringilla! Posuere at diam potenti egestas velit arcu purus lacus sem duis sollicitudin. Parturient ut nibh fringilla pretium. Nunc vehicula velit commodo – egestas, nam nulla nibh etiam sociis. Primis est odio – risus augue curae, neque aptent fermentum, class parturient cubilia elementum aptent, dictum curae integer luctus ad, molestie tristique.
Ipsum fringilla lacinia inceptos habitant, sollicitudin tortor turpis. Justo litora sem potenti auctor ultrices dui aptent turpis primis sed. Cursus faucibus auctor congue enim egestas sodales lacinia semper auctor odio dapibus. Natoque facilisi eleifend erat suscipit odio molestie: donec quisque aenean. Vitae rutrum neque porttitor commodo penatibus, viverra convallis leo odio litora rhoncus magnis inceptos!
Amet nunc ligula dignissim phasellus nostra vel est habitant fringilla. Nunc nunc libero primis sollicitudin erat; vel blandit tellus inceptos. Quis dis suscipit feugiat? Consequat habitant posuere bibendum blandit, cras fringilla nullam blandit dui class. Ornare sollicitudin congue fames proin ornare, suscipit congue iaculis maecenas, a nulla dignissim habitasse ante?
layout_column_wrap() is especially nice for laying out
multiple cards since each card in a particular row will have the same
height (by default). Learn more in column-based layouts.
layout_column_wrap(
width = 1/2,
height = 300,
card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)
navset_card_tab() and navset_card_pill()
make it possible to create cards with multiple tabs or pills. These
functions have the same full_screen capabilities as normal
card()s as well some other options like title
(since there is no natural place for a card_header() to be
used). Note that, each nav_panel() object is similar to a
card(). That is, if the direct children aren’t already card
items (e.g., card_title()), they get implicitly wrapped in a
card_body().
library(leaflet)
navset_card_tab(
height = 450,
full_screen = TRUE,
title = "HTML Widgets",
nav_panel(
"Plotly",
card_title("A plotly plot"),
plotly_widget
),
nav_panel(
"Leaflet",
card_title("A leaflet plot"),
leaflet_widget
),
nav_panel(
shiny::icon("circle-info"),
markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
)
)
card_image() makes it easy to embed static (i.e.,
pre-generated) images into a card. Provide a URL to href to
make it clickable. In the case of multiple card_image()s,
consider laying them out in multiple cards
with layout_column_wrap() to produce a grid of clickable
thumbnails.
Both card() and card_body() default to
fillable = TRUE (that is, they are CSS flexbox
containers), which works wonders for facilitating filling outputs, but it also leads to
surprising behavior with inline tags (e.g., actionButton(),
span(), strings, etc). Specifically, each inline tag is
placed on a new line, but in a “normal” layout flow
(fillable = FALSE), inline tags render inline.
card(
card_body(
fillable = TRUE,
"Here's some", tags$i("inline"), "text",
actionButton("btn1", "A button")
),
card_body(
fillable = FALSE,
"Here's some", tags$i("inline"), "text",
actionButton("btn2", "A button")
)
)
That said, sometimes working in a flexbox layout is quite useful,
even when working with inline tags. Here we leverage flexbox’s gap
property to control the spacing between a plot, a (full-width) button,
and paragraph. Note that, by using markdown() for the
paragraph, it wraps the results in a <p> tag, which
means the contents of the paragraph are not longer subject to
flexbox layout. If we wanted, we could do something similar to render
the actionButton() inline by wrapping it in a
div().
card(
height = 325, full_screen = TRUE,
card_header("A plot with an action links"),
card_body(
class = "gap-2 container",
plotly_widget,
actionButton(
"go_btn", "Action button",
class = "btn-primary rounded-0"
),
markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
)
)
In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.
card(
height = 300, full_screen = TRUE,
card_header(
class = "d-flex justify-content-between",
"Centered plot",
checkboxInput("check", " Check me", TRUE)
),
card_body(
class = "align-items-center",
plotOutput("id", width = "75%")
)
)
Since this article is statically rendered, the examples here use
statically rendered content/widgets, but the same card()
functionality works for dynamically rendered content via Shiny (e.g.,
plotOutput(), plotlyOutput(), etc).
An additional benefit that comes with using shiny is the ability to
use getCurrentOutputInfo() to render new/different content
when the output container becomes large enough, which is particularly
useful with card(full_screen = T, ...). For example, you
may want additional captions/labels when a plot is large, additional
controls on a table, etc (see the value
boxes article for a clever use of this).
# UI logic
ui <- page_fluid(
card(
max_height = 200,
full_screen = TRUE,
card_header("A dynamically rendered plot"),
plotOutput("plot_id")
)
)
# Server logic
server <- function(input, output, session) {
output$plot_id <- renderPlot({
info <- getCurrentOutputInfo()
if (info$height() > 600) {
# code for "large" plot
} else {
# code for "small" plot
}
})
}
shinyApp(ui, server)
The following CSS is used to give plotOutput() a
background color; it’s necessary here because this documentation page is
not actually hooked up to a Shiny app, so we can’t show a real plot.
.shiny-plot-output {
background-color: #216B7288;
height: 400px;
width: 100%;
}
If you want to customize this behavior, you can provide
a function function to wrapper argument (or set it to
NULL to avoid wrapping the non card items in a
container).↩︎